This a technical design document for the HPI Organisation NEMS event. The target audiences are those working on enrolment publisher application, enrolment subscriber applications, and NEMS implementation of HPI events.

Background

Te Whatu Ora Health Identity Team maintains a register of organisation that operate facilities delivering health services, in the Health Provider Index system (HPI).

Organisations are based on legal entities e.g. Company, Charitable Trust, non-registered partnership or Sole Trader.

When changes to Organisations are made with regards to their status and facilities, this information is required by Te Whatu Ora, Accident Compensation Corporation and other organisations for a number of functions including management of contracts, payments and API credentialing.

The HPI Organisation NEMS event will enable subscription to HPI Organisation changes in real-time.

Process view

Event process view:

Organisation events and event data:

Topic taxonomy

For events, the topic taxonomy structure follows the overall topic taxonomy structure:

service-domain/resource/event/verb/version/type

The topic fields are elaborated in the table below (with Dark-green for root taxonomy; Light-green for event property)

Event Topic Field	Field Type	Value	Description
service-domain	Root	“provideridentity”	“provider identity” is the service domain of organisation events
resource	Root	“organisation”	The Organisation resource represents any organisation that provides healthcare services.
event category	Root	“organisation”	The Organisation resource represents any organisation that provides healthcare services.
verb	Root	created, updated	Event action, one of the values
version	Root	“v1”	Starting version
type	Event Property	3 Digit Code	[https://common-ig.hip.digital.health.nz/site/ValueSet-hpi-organisation-type-1.2.html#expansion

Organisation Type Codes

Code	Display	Definition
001	District Health Board (DHB)	DHBs provide (or fund the provision of) health and disability services to 20 districts throughout New Zealand.
003	Government Organisations	This includes both national and local government bodies but excludes DHBs.
006	Responsible Authority	Responsible Authorities are Listed in the Health Practitioners Competency Assurance Act 2003.
007	Research Institutions	Research institutions not involved in education.
008	Education Institutions	Education institutions - these may include those involved in research, e.g. universities.
009	Primary Health Organisation (PHO)	PHOs are the local provider organisations through which DHBs implement the Primary Health Care Strategy.
027	Māori Health Provider	Provider organisations that are owned and governed by Māori and provide services primarily, but not exclusively, to Māori.
028	Pacific Health Provider	Provider organizations that are owned and governed by Pacific people, and provides services primarily but not exclusively for Pacific people.
999	Other

Message header (Event metadata)

Header	Key Literal	Description	Required	Format/Values	Example
ID	solace-user-property-id	Message id, unique for each publisher	Required	GUID correlation ID	987298dd-c484-462f-a15d-f18a97267959
Source	solace-user-property-source	publisher URI reference	Required	https://hip-uat.digital.health.nz for UAT https://hip.digital.health.nz for prod	https://hip-uat.digital.health.nz for UAT and https://hip.digital.health.nz for prod
Time	solace-user-property-time	UTC time when the message is published	Required	YYYY-MM-DDTHH:MM:SS	2023-11-30T18:54:43Z
Spec Version	version	version of the CloudEvents spec	Optional	major.minor	1.0
Type	solace-user-property-type	substring of the topic taxonomy including root to version	Required	{root}/{version}	demographics/patient/death/new/v1.0.0
Subject	solace-user-property-subject	NHI number	Required	[A-Z]{3}([0-9]{4}	([0-9]{2}[A-Z]{2}))
Content type	solace-user-property-datacontenttype or content-type for REST API	Content type of event data	Required	application/json	application/jso

Message payload

HPI Organisation ID

Dormant HPI Organisation IDs

Resource version

Event : created

Payload Schema

{
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "type": "object",
    "properties": {
      "organisationID": {
        "type": "string",
        "description": "Organisation ID"     
      },
      "dormantOrganisationIDs": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Dormant Organisation ID's"
      },
      "resourceVersion": {
        "type": "string",
        "description": "Resource Version"     
      }
    },
    "additionalProperties": false,
    "required": [
      "organisationID",
      "resourceVersion"
    ]
}	

Example

{
 "organisationID": "G00011-K",
 "dormantOrganisationIDs": ["G00010-K"],
 "resourceVersion": "1.4.10"
}

Event : death/update

Payload Schema

As Above

Example

As Above

Event : updated

Payload Schema

Same as above

Example

As above